widgets.brease.WebViewer

Widget Description

short: HTML Content Viewer
de: Zeigt HTML Seiten an, die von einer externen Quelle kommen
en: Displays HTML pages coming from an external source

Properties

name description category type defaultValue bindable readOnly required localizable editableBinding projectable cssProp (has no setter and getter in JS) groupRefId groupOrder nodeRefId (for linking node and value) deprecated typeRefId (for StyleReference) subtype (for MpComIdentReference)
busy Request not yet completed. Behavior Boolean false true true false false false false
enable Initial option to enable widget. Behavior Boolean true true false false false false true
host Hostname or IP of the server the data is to be pulled from. If this is left blank this field will default to value of the source of where the application is running. Common explanation of host, port, path and query: Property specification of the URL. URL is the Uniform Resource Locator where the webpage's address is given. It is written on the format of: http://[host][:port][/path][?query] an example to break down the B&R homepage URL as following to add to the properties: https://www.br-automation.com/en/search/?stype=0&key=mapp%20View explanation: -here the host is: www.br-automation.com -the port is by default 80, and can thus be left at default. -the path is: /en/search/ -the query is: stype=0&key=mapp%20View Data String true false false false false true
path The path of the URL, this is what comes after the port (if given) or after the domain. E.g.: in the url www.example.com/this/is/the/path/ The path field would have to be 'this/is/the/path/' Data String sdm true false false false false true
permissionOperate restricts operability to users, which have given roles Accessibility RoleCollection no defaultValue
defined		 false false false false false true
permissionView restricts visibility to users, which have given roles Accessibility RoleCollection no defaultValue
defined		 false false false false false true
port Port of the server, default value is 80. Data Number 80 true false false false false true
query The query of a URL is the parameters after the & , also known as the GET-parameters. These should be specified as following: single parameter: param=value multiple parameters: param1=value&param2=value&param3=value Data String true false false false false true
src Here the url from the browser can be copied and pasted into, and the webpage will be displayed. The src can be used to specify the entire URL at once on the format: http://[host][:port][/path][?query] E.g.: https://www.br-automation.com/en/search/?stype=0&key=mapp%20View Port 80 is standard for the web and thus doesn't have to be added. Data String true false false true false true
style reference to a style for this widget type Appearance StyleReference default true false false false false true
tabIndex sets if a widget should have autofocus enabled (0), the order of the focus (>0), or if autofocus should be disabled (-1) Behavior Integer -1 false false false false false true
tooltip reference to a tooltip for a widget Appearance String false false false true false true
useURL This option toggles between using the Properties (host, port, path AND query) and the src-property. If true the four properties together will be used to create the url, else the src-option will be used. By default, the URL-properties are used and if not altered these will direct the user to the SDM of the source. Behavior Boolean true true false false false false true
visible change visibility Behavior Boolean true true false false false false true
zIndex The zIndex property specifies the z-order of a widget and its childs.
When widgets overlap, z-order determines which one covers the other. A widget with a larger zIndex generally covers a widget with a lower one.
The zIndex must be unique within a content.
 UInteger no defaultValue
defined		 false false true true true
left absolute position measured from left boundary of parent container Integer no defaultValue
defined		 false false false true true
top absolute position measured from top boundary of parent container Integer no defaultValue
defined		 false false false true true
height outer height of widget Size 200 false false false true true
width outer width of widget Size 300 false false false true true

Styleable Properties

name type description defaultValue
backColor Color

Sets the background color

 transparent
borderColor ColorCollection

Sets the widget's border color, and may have one to four values (starting with the top border, clockwise direction).

 #9A9A9A
borderStyle BorderStyle

Sets the border style of the widget. Options are 'none', solid', 'dashed', 'dotted', 'double', and 'groove'.

 solid
borderWidth PixelValCollection

Sets the widget's border width, and may have one to four values (starting with the top border, in the clockwise direction). Examples: '2px' (all borders set to this value), '2px 10px 2px 2px' (all but right border set to 2px)

 2px 0px 0px 2px
cornerRadius PixelValCollection

Sets the corner radius of the widget's border, and may contain one to four values (starting with the top left corner, in the clockwise direction).

 0px

Events

name description arguments
DisabledClick Fired when disabled element is clicked on.
  • origin: String

    id of widget that triggered this event

  • hasPermission: Boolean

    defines if the state is caused due to missing roles of the current user

  • horizontalPos: String

    horizontal position of click in pixel i.e '10px'

  • verticalPos: String

    vertical position of click in pixel i.e '10px'

EnableChanged Fired when operability of the widget changes.
  • value: Boolean

    operability

FocusIn Fired when the widgets gets focus
FocusOut Fired when the widgets lost focus
VisibleChanged Fired when the visibility of the widget changes.
  • value: Boolean

    visibility

Actions

name description arguments result
Focus Sets focus on the widget element, if it can be focused and keyboardOperation=true
Reload Reloads the configured src/url of the widget.
SetEnable Sets the state of property «enable»
  • value: Boolean

SetHost Sets the host, as in hostname or ip-address.
  • value: String

SetPath Sets the path.
  • value: String

SetPort Sets the port.
  • value: Number

SetQuery Sets the query.
  • value: String

SetSrc Sets the src.
  • value: String

SetStyle
  • value: StyleReference

SetUseURL Sets the value of the option for selecting the source displayed in the widget.
  • value: Boolean

SetVisible Sets the state of property «visible»
  • value: Boolean

ShowTooltip